hipreme_engine v1.0.14 (2023-12-23T18:43:10Z)

HipTextureRegion

hip assets texture
Undocumented in source.
class HipTextureRegion : HipAsset , IHipTextureRegion {
static const
float[8] defaultVertices;
IHipTexture texture;
float u1;
float v1;
float u2;
float v2;
protected
float[8] vertices;
protected
float[8] verticesTransformed;
int regionWidth;
int regionHeight;
bool hasSuccessfullyLoaded();
this();
this(IHipTexture texture, float u1, float v1, float u2, float v2);
this(IHipTexture texture, uint u1, uint v1, uint u2, uint v2);
void setTexture(IHipTexture texture);
const(IHipTexture) getTexture();
IHipTexture getTexture();
int getWidth();
int getHeight();
TextureCoordinatesQuad getRegion();
static Array2D!IHipTextureRegion cropSpritesheet(IHipTexture t, uint frameWidth, uint frameHeight, uint width, uint height, uint offsetX, uint offsetY, uint offsetXPerFrame, uint offsetYPerFrame);
static Array2D!IHipTextureRegion cropSpritesheetRowsAndColumns(IHipTexture t, uint rows, uint columns);
alias setRegion = IHipTextureRegion.setRegion;
void setRegion(float u1, float v1, float u2, float v2);
HipTextureRegion clone();
void setFlippedX(bool flip);
void setFlippedY(bool flip);
bool isFlippedX();
bool isFlippedY();
float[8] getVertices();
void onFinishLoading();
void onDispose();
bool isReady();
}

Constructors

this
this()
Undocumented in source.
this
this(IHipTexture texture, float u1, float v1, float u2, float v2)
Undocumented in source.
this
this(IHipTexture texture, uint u1, uint v1, uint u2, uint v2)
Undocumented in source.

Members

Aliases

setRegion
alias setRegion = IHipTextureRegion.setRegion
Undocumented in source.

Functions

clone
HipTextureRegion clone()
Undocumented in source. Be warned that the author may not have intended to support it.
getHeight
int getHeight()
Undocumented in source. Be warned that the author may not have intended to support it.
getRegion
TextureCoordinatesQuad getRegion()
Undocumented in source. Be warned that the author may not have intended to support it.
getTexture
const(IHipTexture) getTexture()
Undocumented in source. Be warned that the author may not have intended to support it.
getTexture
IHipTexture getTexture()
Undocumented in source. Be warned that the author may not have intended to support it.
getVertices
float[8] getVertices()
Undocumented in source. Be warned that the author may not have intended to support it.
getWidth
int getWidth()
Undocumented in source. Be warned that the author may not have intended to support it.
hasSuccessfullyLoaded
bool hasSuccessfullyLoaded()
Undocumented in source. Be warned that the author may not have intended to support it.
isFlippedX
bool isFlippedX()
Undocumented in source. Be warned that the author may not have intended to support it.
isFlippedY
bool isFlippedY()
Undocumented in source. Be warned that the author may not have intended to support it.
isReady
bool isReady()
Undocumented in source. Be warned that the author may not have intended to support it.
onDispose
void onDispose()
Undocumented in source. Be warned that the author may not have intended to support it.
onFinishLoading
void onFinishLoading()
Undocumented in source. Be warned that the author may not have intended to support it.
setFlippedX
void setFlippedX(bool flip)
Undocumented in source. Be warned that the author may not have intended to support it.
setFlippedY
void setFlippedY(bool flip)
Undocumented in source. Be warned that the author may not have intended to support it.
setRegion
void setRegion(float u1, float v1, float u2, float v2)

Defines a region for the texture in the following order: Top-left Top-Right Bot-Right Bot-Left

setTexture
void setTexture(IHipTexture texture)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

cropSpritesheet
Array2D!IHipTextureRegion cropSpritesheet(IHipTexture t, uint frameWidth, uint frameHeight, uint width, uint height, uint offsetX, uint offsetY, uint offsetXPerFrame, uint offsetYPerFrame)

By passing the width and height values, you'll be able to crop useless frames Default spritesheet method that makes a spritesheet from the entire texture

cropSpritesheetRowsAndColumns
Array2D!IHipTextureRegion cropSpritesheetRowsAndColumns(IHipTexture t, uint rows, uint columns)
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

defaultVertices
float[8] defaultVertices;
regionHeight
int regionHeight;
Undocumented in source.

Variables

regionWidth
int regionWidth;
Undocumented in source.
texture
IHipTexture texture;
Undocumented in source.
u1
float u1;
u2
float u2;
v1
float v1;
v2
float v2;
Undocumented in source.
vertices
float[8] vertices;
Undocumented in source.
verticesTransformed
float[8] verticesTransformed;
Undocumented in source.

Inherited Members

From HipAsset

_name
string _name;

Use it to insert into an asset pool, alias

_assetID
uint _assetID;

Currently not in use

_typeID
uint _typeID;

Usage inside asset manager

startLoadingTimestamp
float startLoadingTimestamp;

When it started loading

loadTime
float loadTime;

How much time it took to load, in millis

name
string name()
Undocumented in source. Be warned that the author may not have intended to support it.
name
string name(string newName)
Undocumented in source. Be warned that the author may not have intended to support it.
assetID
uint assetID()
Undocumented in source. Be warned that the author may not have intended to support it.
typeID
uint typeID()
Undocumented in source. Be warned that the author may not have intended to support it.
onFinishLoading
void onFinishLoading()

Action for when the asset finishes loading Proabably be executed on the main thread

startLoading
void startLoading()
Undocumented in source. Be warned that the author may not have intended to support it.
finishLoading
void finishLoading()
Undocumented in source. Be warned that the author may not have intended to support it.
dispose
void dispose()

Currently, no AssetID recycle is in mind. It will only invalidate the asset for disposing it on an appropriate time

onDispose
void onDispose()

Use it to clear the engine.

Meta

Source

See Implementation

hip assets texture classes

Page generated by adrdox